WIP: Add a .shiny submodule (do not merge)#77
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #77 +/- ##
==========================================
- Coverage 99.00% 97.57% -1.43%
==========================================
Files 16 17 +1
Lines 3208 3255 +47
==========================================
Hits 3176 3176
- Misses 32 79 +47 ☔ View full report in Codecov by Sentry. |
|
Thanks for contributing! I'll try to answer your questions here
I haven't tried it either so I recommend giving it a try locally. If you wanted to build the docs on your machine, run And I'm actually not sure where the docs would go in this case. One option is to just create an article that would go in the user guide. It would be great to document the module in the API reference but it's currently unclear how that could be done.
I have a preference for Polars over Pandas but when I write examples for the User Guide, I try to include example tables that are a mix of Polars, Pandas, or DuckDB (via Ibis). What I'm trying to actively show is that Pointblank generally works well with Narwhals and Ibis backend tables.
Ask me questions anytime! I may not have all the answers but any sort of discussion might help nudge you in the right direction. Hope this helps a bit. This is all new ground so feel free to experiment and change things up as needed! |
|
I've been using pointblank in is several different shiny apps at this point and I think the problem space is too broad to generalize into something like this. I think what I was trying to do here is best accomplished with an example in the shiny docs. I'm gonna close this. Feel free to reopen if you disagree and then I'll take a second crack and at adding documentation for what's already here. |
|
I totally get what you're saying and I think you have the right idea with an example in the Shiny docs! |
Summary
Here's the basic start on adding the
.shinysubmodule. Locally, I've created a little app similar (but better) to the one I posted in Discord.There's still a lot to do (namely tests and docs). The basic premise of the approach is this:
GToutput into a shiny apppb.Validateobject. Wepointblankwill call.interogate()on itGTinstance to preview the data the way the user might want. If this isn't provided, we build a simple one ourselves:I've included a brief app that demonstrates usage.
Questions
server: shinywork with the doc builds? More to the point, how would you like this documented?Related GitHub Issues and PRs
None. Working based on this:
https://discord.com/channels/1345877328982446110/1346204992226197627/1346257619396067400
Checklist
.qmdexample show casing the module's usageExample App
Click to see app source